Details
The implementation architecture of the wrapper service is detailed in this section. In case you want to see the source code in action, please switch to the "Extend" section.
Use
In case you are interested in calling the service from your own implementation, please have a look at the following section. Different integration clients and examples showcase the general applicablility.
Extend
In this seciton, access to the source code is granted. You can download the source package, deploy LoLA on your own infrastructure and change the way the wrapper servic e is working.
Details
The LoLA Wrapper service is implemented as a remote web-service, that allows to trigger LoLA analytical mechanisms through standardized web-service protocols. As such it uses an arbitrary installation of LoLA in a Linux environment as a basis (LoLA functionality and implementation is used as-is, the source code as provided online has been compiled and installed). Using a Java-based implementation, and JAX as a web-service layer, the endpoints are exposed dynamically using annotations for SOAP and ReST.
The wrapper service can be tested and verified using Swagger UI that provides a user interface for the service endpoint. This interfaces is available here. The SOAP specificiation (in WSDL format) and ReST (in WADL format) are accessible here for integration.
Resources:
Use
The wrapper can be called and used remotely using standard mechanisms to interact with web-services. In the following, the steps required to include the functionality in an ADOxx-based tool are shown:
1. Download resources
- RemoteLoLA.asc: this AdoScript enables the communication between your tool and the web-service. It acts as a client to send the content/network to the service, and show the result report for the defined formula/options.
- wget.exe: to enhance the platform functionality, the wget.exe is needed to run downloads/crawls of the results. You can download wget.exe from the developer (http://gnuwin32.sourceforge.net/packages/wget.htm) or as part of the package below.
- curl.exe: to enhance the platform functionality, the curl.exe is needed to run uploads of input files to the server. You can download curl.exe from the developer (http://curl.haxx.se/) or as part of the package below.
2. Extract Archive and Import into Your ADOxx Library
3. Add Menu Entry to Trigger Client
#################################################################
######## REMOTE DOCUMENTATION TRIGGER ########
#################################################################
ITEM "Run LoLA analysis" modeling:"Model verification"
SETG sRemoteLoLAURL:"https://www.adoxx.org/LOLAService/"
EXECUTE file:("db:\\RemoteLoLA.asc")
Extend
The wrapper source code is available via ADOxx.org. Please consider the license conditions as outlined here for the included LoLA exectuable as well as components used to realize the service.
Hints:
Please consider the following configuration entry in
"context.xml":
- The LoLA service is installed on a remote linux server, communication happens through SFTP/SSH.
- The server must be accesible and the Linux user referenced/configured in the wrapper (lola in our case), needs to be the owner of the directory "/tmp/lola". All content is temporarily stored in this folder.